home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 2004 #11 / Amiga Plus CD - 2004 - No. 11.iso / AmiSoft / Text / tex / latex2rtf.lha / latex2rtf / doc / latex2rtf.info < prev    next >
Text File  |  2004-07-23  |  53KB  |  1,357 lines
  1. This is latex2rtf.info, produced by makeinfo version 4.2 from
  2. latex2rtf.texi.
  3.  
  4. 
  5. File: latex2rtf.info,  Node: Top,  Next: Introduction,  Up: (dir)
  6.  
  7. LaTeX2RTF
  8. *********
  9.  
  10.    This file documents LaTeX2RTF , a converter that translates LaTeX
  11. to RTF.
  12.  
  13. * Menu:
  14.  
  15. * Introduction::
  16. * Installation::
  17. * Using LaTeX2RTF::
  18. * Features::
  19. * Configuration::
  20. * Error Messages and Logging ::
  21. * LaTeX2RTF under Development ::
  22. * History::
  23. * Index::
  24.  
  25.    Copyright 1998-2002 Georg Lehner,
  26. updates Copyright 1999-2004 by Wilfried Hennings and Scott Prahl,
  27. with contributions by Mikhail Polianski.
  28.  
  29.    Permission is granted to make and distribute verbatim copies of this
  30. manual provided the copyright notice and this permission notice are
  31. preserved on all copies.
  32.  
  33.    Permission is granted to copy and distribute modified versions of
  34. this manual under the conditions for verbatim copying, provided also
  35. that the sections entitled "Copying" and "GNU General Public License"
  36. are included exactly as in the original, and provided that the entire
  37. resulting derived work is distributed under the terms of a permission
  38. notice identical to this one.
  39.  
  40.    Permission is granted to copy and distribute translations of this
  41. manual into another language, under the above conditions for modified
  42. versions, except that this permission notice may be stated in a
  43. translation approved by the Free Software Foundation.
  44.  
  45. 
  46. File: latex2rtf.info,  Node: Introduction,  Next: Installation,  Prev: Top,  Up: Top
  47.  
  48. Introduction
  49. ************
  50.  
  51.    LaTeX2RTF  is a translator program from LaTeX  text into "rich text
  52. format" files.  These files are commonly referred to as RTF files.  RTF
  53. is a published standard format by Microsoft.  This standard can be
  54. ambiguous in places and Microsoft ignores parts of the standard it
  55. finds inconvenient, but RTF is widely used by many WYSIWIG text editors
  56. and is supported by Microsoft Word and most text processors.
  57.  
  58.    LaTeX2RTF  translates the text and as much of the formatting
  59. information from LaTeX  to RTF.  Be forewarned that the typeset output
  60. is not nearly as good as what you would get from using LaTeX  directly.
  61. So, why bother translating? Consider,
  62.  
  63.   1. You use LaTeX  and hate everything beginning with MS-....
  64.      Nevertheless, you have to share your documents with people who
  65.      don't even now that there exist other things than MS-....
  66.  
  67.   2. You know somebody who frequently sends you very fine LaTeX
  68.      documents. Unfortunately, you are "on the other side" and need to
  69.      import her files, steal some part, and then desktop publish it in
  70.      your fine MS-... environment.
  71.  
  72.  
  73.    There are drawbacks to the conversion process. In fact, don't expect
  74. any LaTeX  file to be converted as you would like, don't expect it to
  75. be converted without errors or warnings, and don't be especially
  76. surprised when it doesn't convert at all.  LaTeX2RTF  is known to have
  77. many bugs and many missing features. Paradoxically, this number seems to
  78. grow more and more with each day.  However, we can categorically state
  79. that there are some special cases,  in which a LaTeX  file will be
  80. translated to RTF satisfactorily by LaTeX2RTF  -- This was sort of
  81. disclaimer, ok? OK!
  82.  
  83.    LaTeX  is a system for typesetting text and therefore it focuses on
  84. the logical structure of a document, whilst RTF is meant to be a
  85. transport format for a family of Desktop Publishing Software, dealing
  86. mostly with the design of a text.
  87.  
  88.    Although the possible different commands and styles in LaTeX  are
  89. much more flexible and standardized than in RTF, only a small subset of
  90. commands has been implemented to date.  *Note Unimplemented Features::.
  91.  
  92.    Some of the capabilities of LaTeX2RTF  are restricted in scope or
  93. buggy. *Note Known Bugs::.
  94.  
  95.    RTF is a moving target, because Microsoft does not stop inventing
  96. new extensions and features, consequently you cannot view newer RTF
  97. files with older word processors.  The syntax and semantics of RTF are
  98. somewhat artistic, i.e., you can generate a syntactically correct RTF
  99. file that cannot be displayed by some/most word processors.  For more
  100. details on RTF the specification consult the links at
  101. `http://latex2rtf.sf.net/'
  102.  
  103. 
  104. File: latex2rtf.info,  Node: Installation,  Next: Using LaTeX2RTF,  Prev: Introduction,  Up: Top
  105.  
  106. Installation
  107. ************
  108.  
  109. * Menu:
  110.  
  111. * General ::
  112. * Obtaining LaTeX2RTF ::
  113. * UNIX ::
  114. * DOS or Windows ::
  115. * Win32 systems ::
  116. * Macintosh ::
  117. * Problems Compiling ::
  118. * Problems with make check ::
  119.  
  120. 
  121. File: latex2rtf.info,  Node: General,  Next: Obtaining LaTeX2RTF,  Prev: Installation,  Up: Installation
  122.  
  123. General
  124. =======
  125.  
  126.    The documentation of the program is found in the `doc/' directory in
  127. the file `latex2rtf.texi' in the GNU TeXInfo format.  For your
  128. convenience, you can find HTML and PDF versions of the manual there as
  129. well.
  130.  
  131. 
  132. File: latex2rtf.info,  Node: Obtaining LaTeX2RTF,  Next: UNIX,  Prev: General,  Up: Installation
  133.  
  134. Obtaining LaTeX2RTF
  135. ===================
  136.  
  137.    LaTeX2RTF  is available for many Unix Platforms, for the Macintosh,
  138. and for MS-DOS, including all versions of MS Windows.
  139.  
  140.    The latest version of LaTeX2RTF  is available at SourceForge
  141. (http://sourceforge.net/projects/latex2rtf/) and -- with some delay --
  142. on CTAN sites: e.g., `http://www.dante.de' or `http://www.ctan.org'.
  143.  
  144.    The MS-DOS version (1.8aa and up) will also run under all MS Windows
  145. versions. It requires an i386 processor or better.
  146.  
  147.    The Win32 distribution (starting from LaTeX2RTF  1.9.15) is the
  148. MS-DOS version plus Win32 GUI program (l2rshell).
  149.  
  150.    There are a couple of people working on the LaTeX2RTF , coordinated
  151. by Wilfried Hennings (W.Hennings "at" fz-juelich.de).  See the
  152. SourceForge (http://sourceforge.net/projects/latex2rtf/) project pages
  153. for the latest news.
  154.  
  155. 
  156. File: latex2rtf.info,  Node: UNIX,  Next: DOS or Windows,  Prev: Obtaining LaTeX2RTF,  Up: Installation
  157.  
  158. UNIX
  159. ====
  160.  
  161.    To install,
  162.   1. Edit `Makefile' for your local configuration.  In particular, pay
  163.      attention to the `PREFIX' variable.  If you do not have root
  164.      access you might wish to set the makefile variable `PREFIX' to be
  165.      your home directory.
  166.  
  167.      On some machines the cc compiler will issue errors. Therefore the
  168.      default compiler command in the Makefile is `CC=gcc'.
  169.  
  170.   2. As of version 1.9.13, LaTeX2RTF  supports conversion of LaTeX
  171.      equations to bitmaps using the shell script `latex2png', found in
  172.      `scripts/'.  `latex2png' requires that both LaTeX  and
  173.      `ImageMagick' are installed.  LaTeX2RTF  will translate documents
  174.      without a working `latex2png', but some features will be missing.
  175.      You can verify that the `latex2png' script is working by typing
  176.      `make' in the `scripts/' directory.
  177.  
  178.   3. `make'
  179.  
  180.      If this is not your first time installation, you may want to
  181.      preserve   your old configuration (`*.cfg') files. Copy them to a
  182.      safe place before   installing.
  183.  
  184.      On IBM AIX, the IBM make utility does not support some of the
  185.      commands used in Makefile. In this case use `gmake' (from GNU)
  186.      instead.
  187.  
  188.      Sun has decided to support the XPG4 standard on Solaris by an
  189.      alternative set of binaries.  So allow bitmap conversion of
  190.      equations, two things are needed.  First, change the first line of
  191.      latex2png to `#!/usr/xpg4/bin/sh' Second, define the XPG4_GREP
  192.      environment variable accordingly, for bash-like shells
  193.      `XPG4_GREP=/usr/xpg4/bin/grep; export XPG4_GREP' or for tsch-like
  194.      shells `setenv XPG4_GREP /usr/xpg4/bin/grep'.
  195.  
  196.   4. `make install'
  197.  
  198.      If your `mkdir' doesn't support the `-p' option, then create   the
  199.      necessary directories by hand and remove the option from the
  200.      `$MKDIR' variable.    If you have other problems, just copy
  201.      `latex2rtf' and `latex2png' to   a binary directory, and move the
  202.      contents of the `cfg/' directory to   the location specified by
  203.      `$CFG_INSTALL'.
  204.  
  205.   5. `make check'
  206.  
  207.      [OPTIONAL] This tests LaTeX2RTF  on a variety of LaTeX  files.
  208.      Expect a whole lot of warnings, but no outright errors. (On IBM
  209.      AIX, use `gmake check'.)  Note that this will check the basic
  210.      functionality of the `latex2png' script, and then that of
  211.      `latex2rtf'.
  212.  
  213.   6. `make install-info'
  214.  
  215.      [OPTIONAL] This installs `.info' files for use with the `info'
  216.      program.
  217.  
  218.  
  219.    You no longer need to define the environment variable `RTFPATH'. This
  220. is only necessary if you move the directory containing the `.cfg' files.
  221. Just define `RTFPATH' to be the path to the new location.
  222.  
  223. 
  224. File: latex2rtf.info,  Node: DOS or Windows,  Next: Win32 systems,  Prev: UNIX,  Up: Installation
  225.  
  226. DOS or Windows
  227. ==============
  228.  
  229.    The UNIX and Mac distributions do not contain an executable for DOS
  230. or Windows. Instead, get the DOS port as file `latex2rtf-x.x.x_dos.zip'
  231. or the Windows (Win32 = Win95, Win98, WinME, WinNT, Win2000, WinXP)
  232. version as file `latex2rtf-x.x.x_win.exe' (where x.x.x is the version
  233. number) from SourceForge (http://sourceforge.net/projects/latex2rtf/)
  234. The DOS distribution contains a precompiled executable which should run
  235. under plain DOS and also in the command prompt (or "console") of any MS
  236. Windows system.
  237. The Win32 version starting from 1.9.14a has the same executable but
  238. additionally an optional Win32 GUI interface (LaTeX2RTF Shell) and is
  239. wrapped in an automatic installer, *Note Win32 systems::.
  240. To install latex2rtf, extract all files from the zip archive to `C:\l2r'
  241. or to another folder (i.e. directory) of your choice, preserving the
  242. folder structure (winzip: check "use folder names").
  243. If you extracted them to another folder (e.g. `C:\Program Files\l2r'),
  244. edit the files `L2R.BAT', `L2RSEM.BAT' and `L2RPREP.BAT' and change the
  245. folder `C:\l2r' to where you put them.  If there is a blank in any of
  246. the folder names (as in e.g. "Program Files"), then you need to enclose
  247. both the file-ID and the cfg path in double quotes, e.g.
  248. `"C:\Program Files\l2r\latex2rt" -P "C:\Program Files\l2r\cfg" %1 %2
  249. ...'
  250. or use the DOS filename equivalent instead, e.g.
  251. `C:\Progra~1\l2r\latex2rt -P C:\Progra~1\l2r\cfg %1 %2 ...'
  252.  
  253.    If you install LaTeX2RTF  under WinNT, Win2000 or WinXP and you want
  254. other users to be able to use LaTeX2RTF , you must assign the files and
  255. folders appropriate user permissions (at least read & execute).  If you
  256. don't know about user permissions, put LaTeX2RTF  into `C:\Program
  257. Files\l2r' or what else the standard folder for installing applications
  258. is named (e.g. in the German version it is `C:\Programme\l2r').
  259.  
  260.    Make sure that the folder containing the file `L2RPREP.BAT' is in
  261. your search path, or put this file into a folder which is in your
  262. search path (e.g. `C:\Windows').
  263. To display the current search path, enter `path' from the command
  264. prompt (with no arguments).
  265.  
  266.    To add a folder - e.g. C:\l2r - to the search path:
  267.    * DOS, Win3.1, Win95, Win98, WinME
  268.         * Open the file `C:\Autoexec.bat' either with Edit (DOS) or
  269.           with Notepad (Windows).
  270.  
  271.         * At the end of that file, add the line
  272.           `PATH=C:\l2r;%PATH%'
  273.  
  274.         * Save the file to its original location.
  275.  
  276.    * WinNT, Win2000, WinXP
  277.         * Right-click "My Computer" (German: "Arbeitsplatz"), then
  278.           select "Properties";
  279.  
  280.         * NT: Click the "Environment" tab;
  281.           XP: Click the "Extended" tab, then the "Environment
  282.           variables" button;
  283.  
  284.         * Find the line beginning with `PATH=' and insert the string
  285.           `C:\l2r;'
  286.           so that the complete line looks like
  287.           `PATH=C:\l2r;C:\WINDOWS;...'
  288.  
  289.         * Click "OK"
  290.  
  291.    To start the program under Windows,
  292. open a command prompt (or console window)
  293. - under DOS you are already at the command prompt -,
  294. use `cd <folder>' to make the folder with your TeX files the current
  295. folder,
  296. then enter either `L2R <filename> <options>' or `L2RSEM <filename>
  297. <options>'
  298. where <filename> is the name of your TeX file without the .tex
  299. extension.
  300. `L2R.BAT' and `L2RSEM.BAT' only differ in the character being used as
  301. parameter separator in the EQ fields, see chapter *Note Equations::.
  302.  
  303.    If your LaTeX  document refers to external graphic files, e.g. eps,
  304. or you want to use the option to convert equations to bitmaps (-M# where
  305. # is greater than 3), you must have TeX, ImageMagick and Ghostscript
  306. installed.  These programs are freely available for download at
  307. `http://www.miktex.org/', `http://www.imagemagick.org' and
  308. `http://www.ghostscript.com'.  This works only on win32 systems (Win95,
  309. Win98, WinME, WinNT4, Win2000, WinXP) because ImageMagick is available
  310. only for win32, not for pure DOS.
  311.  
  312.    Either the folders where TeX, ImageMagick and Ghostscript are
  313. installed must be in your search path, or you must edit the file
  314. `L2RPREP.BAT', ensure that the pathes in this file point to the folders
  315. where TeX, ImageMagick and Ghostscript are installed on your machine,
  316. and call `L2RPREP' once after opening your command prompt window and
  317. before calling `l2r', `l2rsem' or `latex2rt'.  Under Windows you can
  318. create another command prompt link in which you can include the call to
  319. `L2RPREP.BAT'.
  320.  
  321.    LaTeX2RTF  first writes a temporary .tex file to disk which consists
  322. of only the equation to be converted. It then sends the call for
  323. latex2pn.bat to the operating system. There were problems that this
  324. didn't work although manually calling latex2pn.bat from the command
  325. prompt worked.
  326. There were several bugs in interfacing between Windows XP and DJGPP
  327. which finally caused this. One fix needed was truncating the filename of
  328. `latex2png.bat' to the DOS convention of 8.3 characters so that it is
  329. now named `latex2pn.bat' and the executable program `latex2rt.exe'.
  330. The other fix is now hardcoded in latex2rt.exe, making sure the DOS
  331. environment space in which latex2pn.bat is executed is large enough to
  332. store the needed variables.
  333.  
  334. 
  335. File: latex2rtf.info,  Node: Win32 systems,  Next: Macintosh,  Prev: DOS or Windows,  Up: Installation
  336.  
  337. Win32 systems
  338. =============
  339.  
  340.    To install LaTeX2RTF  on a Win32 system (Win9x, WinME, WinNT,
  341. Win2000, WinXP), download and execute the `latex2rtf-x.x.x_win.exe'
  342. (where x.x.x is the version number) and follow the instructions.
  343.  
  344.    To start the program double-click the LaTeX2RTF  icon, or drag and
  345. drop a `.tex' file onto the icon.
  346.  
  347.    If your LaTeX  document refers to external graphic files, e.g. eps,
  348. or you want to use the option to convert equations to bitmaps, you must
  349. have LaTeX, ImageMagick and Ghostscript installed. These programs are
  350. freely available for download at `http://www.miktex.org/',
  351. `http://www.imagemagick.org' and `http://www.ghostscript.com'
  352.  
  353.    Paths to LaTeX, ImageMagick and Ghostscript executables have to be
  354. specified in the "Environment" tab of the LaTeX2RTF  window.
  355.  
  356. 
  357. File: latex2rtf.info,  Node: Macintosh,  Next: Problems Compiling,  Prev: Win32 systems,  Up: Installation
  358.  
  359. Macintosh
  360. =========
  361.  
  362.    If you want a MacOS X version, make sure that you have installed the
  363. developer tools CD that is appropriate for your OS version, and then
  364. follow the directions above for UNIX installation.
  365.  
  366.    There is a classic MacOS PPC port of the 1.9k of LaTeX2RTF  and I
  367. have made a binary distribution of this application.  Unfortunately,
  368. because I (Scott Prahl) do all development under MacOS X, the binaries
  369. for the Classic version often lag (far) behind the current UNIX version.
  370.  
  371.    To convert a LaTeX  file, just drag the file onto the LaTeX2RTF
  372. application icon.  The translation is best if there are `.aux' and
  373. `.bbl' files in the same folder as the `.tex' file to be converted.
  374. These should be generated using LaTeX  and `bibtex'.
  375.  
  376. 
  377. File: latex2rtf.info,  Node: Problems Compiling,  Next: Problems with make check,  Prev: Macintosh,  Up: Installation
  378.  
  379. Problems Compiling
  380. ==================
  381.  
  382.    The code for LaTeX2RTF  is standard ANSI C.  Some possible pitfalls
  383. are
  384.    * Not correctly defining your compiler in the Makefile.  The default
  385.      is to use `gcc'.
  386.  
  387.    * Encountering errors because the compiler options.  During
  388.      development all compiler warnings are turned on.  However,
  389.      different compilers have different interpretations of `-Wall' and
  390.      may generate errors that were not found in a different development
  391.      system.  Please report these, but a quick fix is to remove all
  392.      compiler options.
  393.  
  394.  
  395. 
  396. File: latex2rtf.info,  Node: Problems with make check,  Prev: Problems Compiling,  Up: Installation
  397.  
  398. Problems with `make check'
  399. ==========================
  400.  
  401.    All the files in the `test' directory are converted (with varying
  402. degrees of success) using LaTeX2RTF  and are tested before most CVS
  403. check-ins and with all released tarballs.  There will be many warning
  404. messages, but there should be no actual error messages.  If you do not
  405. have a working latex2png script, then some of the files will fail to be
  406. translated.
  407.  
  408. 
  409. File: latex2rtf.info,  Node: Using LaTeX2RTF,  Next: Features,  Prev: Installation,  Up: Top
  410.  
  411. Using LaTeX2RTF
  412. ***************
  413.  
  414. * Menu:
  415.  
  416. * General Assumptions ::
  417. * LaTeX2RTF Options ::
  418. * Debugging::
  419.  
  420. 
  421. File: latex2rtf.info,  Node: General Assumptions,  Next: LaTeX2RTF Options,  Prev: Using LaTeX2RTF,  Up: Using LaTeX2RTF
  422.  
  423. General Assumptions
  424. ===================
  425.  
  426.    LaTeX2RTF  assumes that the `.tex' file you want to convert is a
  427. valid LaTeX  document.  The chances of a successful LaTeX2RTF
  428. conversion are slightly better than the proverbial snowball's if the
  429. `.tex' file doesn't `latex' properly.  Use LaTeX  to find and correct
  430. errors before using LaTeX2RTF .
  431.  
  432.    To correctly convert font names you must edit the `fonts.cfg'
  433. configuration file.  This file is used to specify the needed font names
  434. and how the LaTeX  default font names should be converted to RTF.
  435. *Note Font Configuration::. LaTeX  variables and user defined commands
  436. are not evaluated. They will be simply ignored. To let LaTeX2RTF  know
  437. the names of variables you can add them in the `ignore.cfg' file.
  438. *Note Ignore Command::.
  439.  
  440.    The environment variable RTFPATH may contain a search path for the
  441. support files (all files ending in `.cfg'). If no file is found during
  442. the search in the search-path or if the environment variable is not
  443. set, the compiled-in default for the configuration-file directory is
  444. used. If the files are not found at all the program aborts.
  445.  
  446.    In the MS-DOS version the search path is separated by `;' in the
  447. Unix version by `:'. For the paths themselves apply `\' and `/'. A
  448. separator may appear at the beginning or ending of RTFPATH.
  449.  
  450.    Make sure that the configuration files are in the correct directory.
  451. LaTeX2RTF  will need at least `fonts.cfg', `direct.cfg', `ignore.cfg',
  452. `english.cfg'. You may have to change one ore more of them to suit your
  453. needs. *Note Configuration::.
  454.  
  455.    *Note Missing options::, for actual implementations irregularities.
  456.  
  457.    *Note Reporting Bugs::, for information on how to reach the
  458. maintainer.
  459.  
  460. 
  461. File: latex2rtf.info,  Node: LaTeX2RTF Options,  Next: Debugging,  Prev: General Assumptions,  Up: Using LaTeX2RTF
  462.  
  463. LaTeX2RTF Options
  464. =================
  465.  
  466.    The LaTeX2RTF  command converts a LaTeX  file into RTF text format.
  467. The text and much of the formatting information is translated to RTF
  468. making the new file look similar to the original.  The command line
  469. syntax is:
  470.  
  471.      latex2rtf [-options] inputfile.[tex]
  472.  
  473.    The `-options' may consist of one or more of the following
  474.  
  475. `-a auxfile'
  476.      specify an `.aux' file (for table and figure references) that
  477.      differs from `inputfile.aux'. If this is omitted, the name of the
  478.      inputfile with the suffix replaced `.aux''will be taken.  You must
  479.      provide both files (`.tex' and the `.aux') to be able to convert
  480.      cross-references in a LaTeX  file.  The `.aux' is created by
  481.      running the `inputfile.tex' through `latex'.
  482.  
  483. `-b bblfile'
  484.      Unless an `bblfile' is specified with the `-b' option, LaTeX2RTF
  485.      uses a `inputfile.bbl'.  The `bblfile' file is used for citations
  486.      and is typically created by running `inputfile.aux' through
  487.      `bibtex'.
  488.  
  489. `-C codepage'
  490.      used to specify the character set (code page) used in the LaTeX
  491.      document. This is only important when non-ansi characters are
  492.      included in the LaTeX  document. Typically this is done in a
  493.      LaTeX2e  file by using `\usepackage[codepage]{inputenc}' This
  494.      command is not needed if the above command is already in the
  495.      LaTeX2e  file.  You may select any of the following code pages:
  496.      ansinew, applemac, cp437, cp437de, cp850, cp852, cp865, decmulti,
  497.      cp1250, cp1252, latin1, latin2, latin3, latin4, latin5, latin9,
  498.      next.  The default behavior is to use ansinew (code page 1252).
  499.      Cyrillic support includes conversion of koi8-r, koi8-u, cp1251,
  500.      cp855, cp866, maccyr, and macukr encodings.
  501.  
  502. `-d debug_level'
  503.      The `-d' option determines the amount of debugging information to
  504.      send to stderr while translating. debug_level=0 means only Errors,
  505.      `1' Warning Messages (default) also.  The debug_level can go as
  506.      high as `7' for insane amounts of debugging fun.
  507.  
  508. `-D dots_per_inch'
  509.      used to specify the number of dots per inch for equations
  510.      converted to bitmaps.  This value is also used when picture
  511.      environments are converted to bitmaps as well as when EPS graphics
  512.      are converted to png files.  The default value is 300 dots per
  513.      inch.
  514.  
  515. `-f#'
  516.      where # selects which fields to use during conversion:
  517.     `-f0'
  518.           do not use fields in RTF.  This is handy when primitive RTF
  519.            editors are being used to view the RTF output.
  520.  
  521.     `-f1'
  522.           use fields for equations but not `\ref' and `\cite'.
  523.  
  524.     `-f2'
  525.           use fields for `\ref' and `\cite' but not equations.  This
  526.           will be useful for versions of OpenOffice that import
  527.           cross-references     properly (as of Sept 2003 in a
  528.           soon-to-be released version) but do not properly     handle
  529.           fields in equations.
  530.  
  531.     `-f3'
  532.           use fields when possible.  This is the default and is most
  533.           useful when     the RTF file is being exported to be used in
  534.           Word.  This retains the most     information from the
  535.           original LaTeX  file.
  536.  
  537. `-F'
  538.      use LaTeX to create bitmaps for all figures.  This may help when
  539.      figures are not translated properly with the default settings.
  540.      This typically requires a functional version of ImageMagick on
  541.      your machine to work properly.
  542.  
  543. `-h'
  544.      a short usage description
  545.  
  546. `-i language'
  547.      used to set the idiom or language used by the LaTeX  document.
  548.      Typically, this is specified in a LaTeX2e  document by including
  549.      `\usepackage[language]{babel}' where `language' is one of the
  550.      languages supported by the `babel' package.   All languages listed
  551.      in the babel system are supported so far as translations for
  552.      "Chapter," "References," and the like.  Furthermore, some commands
  553.      found in the style files for german, french, russian, and czech
  554.      style are supported. *Note Language Configuration::.
  555.  
  556. `-l'
  557.      same as `-i latin1' (Note that the default behavior is to use
  558.      `ansinew' which is a superset of `latin1'). Included for backwards
  559.      compatibility.
  560.  
  561. `-M#'
  562.      where # selects the type of equation conversion.  Use
  563.     `-M1'
  564.           convert displayed equations to RTF
  565.  
  566.     `-M2'
  567.           convert inline equations to RTF
  568.  
  569.     `-M4'
  570.           convert displayed equations to bitmap
  571.  
  572.     `-M8'
  573.           convert inline equations to bitmap
  574.  
  575.     `-M16'
  576.           insert Word comment field that contains the original equation
  577.           text     These switches can be added together to get the
  578.      desired conversion.  Handy examples are
  579.     `-M3'
  580.           convert both inline and displayed equations to RTF (default)
  581.  
  582.     `-M6'
  583.           convert inline equations to RTF and displayed equations to
  584.           bitmaps
  585.  
  586.     `-M12'
  587.           convert both inline and displayed equations to bitmaps
  588.      Bitmap conversion requires that you have installed a working
  589.      latex2png script.  Producing bitmaps is slow.
  590.  
  591. `-o outputfile'
  592.      Unless an `outputfile' is specified with the `-o' option, the
  593.      resulting RTF filename is formed by removing `.tex' from the
  594.      `inputfile' and appending `.rtf'.
  595.  
  596. `-p'
  597.      Do not quote printed parentheses in mathematical formulas, as some
  598.      versions of Word (e.g., Word 2000) have deep psychological
  599.      problems with EQ fields using quoted parentheses.  If Word
  600.      displays some formulas with parentheses as "Error!", try this
  601.      option.  See also the -S option.
  602.  
  603.      This is an option because it will break typesetting equations with
  604.      non-matching parentheses (because an unmatched unquoted
  605.      parenthesis would terminate the field).
  606.  
  607. `-P /path/to/cfg'
  608.      used to specify the directory that contains the `.cfg' files
  609.  
  610. `-S'
  611.      used to specify that semicolons should be used to separate
  612.      arguments in RTF fields (instead of commas).  Typically this is
  613.      needed when the machine that opens the RTF file has a version of
  614.      Windows that uses `,' for decimal points.
  615.  
  616. `-V'
  617.      prints version information on standard output and exits.
  618.  
  619. `-W'
  620.      includes warnings directly in the RTF file
  621.  
  622. `-Z#'
  623.      add the specified number of extra `}' to the end of the RTF file.
  624.      This is useful for files that are not cleanly converted by
  625.      LaTeX2RTF .
  626.  
  627.    With no arguments other than switches starting with a "-", LaTeX2RTF
  628. acts as a filter, i.e., it reads from `stdin' and writes to `stdout'.
  629. In addition, diagnostic messages are sent to `stderr'. If these standard
  630. channels are not redirected using `<' and `>', then the input is read
  631. from the command line, and both output and error messages are printed
  632. on the screen.
  633.  
  634.    If a non-switch argument is present, LaTeX2RTF  assumes it is the
  635. name of the input file. The file must have extension ".tex" but the
  636. extension is optional. The output file is constructed from the input
  637. file name by removing the extension ".tex" and adding ".rtf".
  638.  
  639. 
  640. File: latex2rtf.info,  Node: Debugging,  Prev: LaTeX2RTF Options,  Up: Using LaTeX2RTF
  641.  
  642. Debugging
  643. =========
  644.  
  645.    With the `-d' option you can specify how much processing information
  646. LaTeX2RTF  reports.  If there is a logfile specified the output goes to
  647. this file. Nonetheless Warnings and Errors are logged to stderr always.
  648.  
  649.    Possible values of `-d' are
  650.   0. only errors.
  651.  
  652.   1. Translation Warnings (default).
  653.  
  654.   2. shows preparsing of sections
  655.  
  656.   3. Reasonably high level debugging messages
  657.  
  658.   4. Show all function calls
  659.  
  660.   5. Show all each character as it is processed
  661.  
  662.   6. Show processing of characters as they are output as well
  663.  
  664. 
  665. File: latex2rtf.info,  Node: Features,  Next: Configuration,  Prev: Using LaTeX2RTF,  Up: Top
  666.  
  667. Features
  668. ********
  669.  
  670.    In this chapter you find what styles is LaTeX2RTF  supposed to
  671. translate correctly to RTF.
  672.  
  673. * Menu:
  674.  
  675. * LaTeX2e::
  676. * Input Encoding ::
  677. * Language Support ::
  678. * Cross References ::
  679. * Equations ::
  680. * Tables ::
  681. * Graphics ::
  682. * Pagestyles ::
  683. * Hyperlatex ::
  684.  
  685. 
  686. File: latex2rtf.info,  Node: LaTeX2e,  Next: Input Encoding,  Prev: Features,  Up: Features
  687.  
  688. LaTeX2e
  689. =======
  690.  
  691.    LaTeX2RTF  understands most of the commands introduced with LaTeX2e
  692. .  It supports both the old 2.09 version of
  693. `\documentstyle[options]{format#}' and the newer
  694. `\documentclass[options]{format}'.
  695.  
  696. 
  697. File: latex2rtf.info,  Node: Input Encoding,  Next: Language Support,  Prev: LaTeX2e,  Up: Features
  698.  
  699. Input Encoding
  700. ==============
  701.  
  702.    It is not necesary to specify the `-C' option if you use
  703. `\usepackage{isolatin1}' or `\documentstyle[isolatin1]{...}'. LaTeX2RTF
  704. automagically detects these packages/style options and switches to
  705. processing of ISO-Latin1 codes.  The following encodings are supported:
  706. ansinew, applemac, cp437, cp437de, cp850, cp852, cp865, decmulti,
  707. cp1250, cp1252, latin1, latin2, latin3, latin4, latin5, latin9, next,
  708. koi8-r, koi8-u, cp1251, cp855, cp866, maccyr, and macukr.  The encoding
  709. used in RTF files is cp1252.  If cyrillic fonts are present, then these
  710. are represented in the RTF file using cp1251 (Windows Cyrillic).
  711.  
  712. 
  713. File: latex2rtf.info,  Node: Language Support,  Next: Cross References,  Prev: Input Encoding,  Up: Features
  714.  
  715. Language Support
  716. ================
  717.  
  718.    The following languages from the Babel package are supported:
  719. afrikaans, german, nynorsk, spanish, bahasa, dutch, icelandic, polish,
  720. swedish, basque, english, portuges, turkish, brazil, esperanto, irish,
  721. romanian, usorbian, breton, estonian, italian, samin, welsh, catalan,
  722. finnish, latin, scottish, croatian, lsorbian, serbian, czech, french,
  723. magyar, slovak, danish, galician, norsk, slovene,
  724.  
  725.    The only thing that these files do is to translate various words
  726. usually emitted by LaTeX  during processing.  For example, this ensures
  727. that the LaTeX2RTF  will provide the correct translation of the word
  728. "Chapter" in the converted document.
  729.  
  730.    You can select any of the above languages using the `-l' option.
  731. This is not needed if your LaTeX  file contains
  732. `\usepackage[language]{babel}'.
  733.  
  734.    Encountering the `german' package or documentstyle option (by H.
  735. Partl of the Viena University) makes LaTeX2RTF  behave like that:
  736. German Quotes, German Umlauts by `"a', etc....  This support is
  737. programmed directly into LaTeX2RTF  and supporting similar features for
  738. other languages will require patching the source code.
  739.  
  740.    *Note Language Configuration::, for details on how to write a
  741. `language.cfg' file for your language by yourself.
  742.  
  743. 
  744. File: latex2rtf.info,  Node: Cross References,  Next: Equations,  Prev: Language Support,  Up: Features
  745.  
  746. Cross References
  747. ================
  748.  
  749.    Cross references include everything that you might expect and then
  750. some: bibliographic citations, equation references, table references,
  751. figure references, and section references.  Section, equation, table
  752. and figure references are implemented by placing RTF bookmarks around
  753. the equation number (or table number or figure number).
  754.  
  755.    Page references work but are implemented as "warm" cross-references.
  756. This means that Word does not automatically update the page references
  757. when the file is opened.  To update the page references you must select
  758. the entire document (in Word) and press `F9'.
  759.  
  760.    Bibliographic references currently require that a valid `.aux' file
  761. be present.  This is where LaTeX2RTF  obtains the reference numbers.
  762. It would be nice if LaTeX2RTF  just automatically numbered the
  763. references when there was no `.aux' file, but LaTeX2RTF  does not do
  764. this yet.
  765.  
  766.    Footnotes are implemented and appear at the bottom of each page.
  767.  
  768.    Indexing is reasonable well supported.  The simple mark-up of
  769. `makeindex'
  770.      \index{topic!subtopic@\textit{subtopic}}
  771.    is supported.  The rest of the fancy indexing stuff is not
  772. implemented.  The index is created at the location of the `\printindex'
  773. command.  When a file with an index is first opened in Word, you must
  774. select the entire file and update the page references and fields by
  775. pressing `F9'.
  776.  
  777.    Currently, there is no support for `\labels' of `\item's in
  778. enumerate environments.
  779.  
  780.    The conversion of cross-references is not perfect because of the
  781. different mechanisms in the LaTeX  and Word worlds.  In particular, if
  782. there are multiple `\label' in a figure, table, or section environment
  783. then only the first gets processed.  It is also possible to confuse the
  784. LaTeX2RTF  in eqnarray environments.
  785.  
  786. 
  787. File: latex2rtf.info,  Node: Equations,  Next: Tables,  Prev: Cross References,  Up: Features
  788.  
  789. Equations
  790. =========
  791.  
  792.    There are four separate levels of equation translation based on the
  793. -M switch, *Note LaTeX2RTF Options::.  Each equation is now converted
  794. either to an EQ field or to a bitmap.
  795.  
  796.    This is an interim solution (for some definition of "interim").
  797. Ideally the equations would become OLE equation objects in the RTF
  798. file, but this needs to be implemented.
  799.  
  800.    Some functions in the EQ fields have two or more parameters with a
  801. separator between each two. Unfortunately, the interpretation of these
  802. separators depends on the country specific settings in the MS Windows
  803. system in which the rtf file is opened. E.g. in English versions of MS
  804. Windows, the default parameter separator is the comma, in German
  805. versions the default is the semicolon. If the parameter in the RTF file
  806. does not match the Windows setting, some EQ fields are not interpreted
  807. correctly. You can check and set the separator in [Windows control panel
  808. - country settings - numbers - list separator]. By default, latex2rtf
  809. uses the comma as separator. If latex2rtf is called with the command
  810. line parameter -S , the semicolon is inserted as parameter delimiter.
  811.  
  812. 
  813. File: latex2rtf.info,  Node: Tables,  Next: Graphics,  Prev: Equations,  Up: Features
  814.  
  815. Tables
  816. ======
  817.  
  818.    The table code is currently barely working.  It needs to be
  819. rewritten.
  820.  
  821. 
  822. File: latex2rtf.info,  Node: Graphics,  Next: Pagestyles,  Prev: Tables,  Up: Features
  823.  
  824. Graphics
  825. ========
  826.  
  827.    There is now rudimentary support for `\includegraphics'.  Three file
  828. types will be inserted into the RTF file without needing conversion:
  829. .pict, .jpeg, and .png files.  EPS files are converted to PNG using
  830. `convert' from the ImageMagick package.
  831.  
  832. 
  833. File: latex2rtf.info,  Node: Pagestyles,  Next: Hyperlatex,  Prev: Graphics,  Up: Features
  834.  
  835. Pagestyles
  836. ==========
  837.  
  838.    If there is no `\pagestyle' command, the RTF output is generated as
  839. with plain pagestyle, i.e. each page get's its page number centered at
  840. the bottom.
  841.  
  842.    You must turn this off with the \pagestyle{empty} command in the
  843. LaTeX  file if you don't want pagenumbers.  The headings and myheadings
  844. styles are silently ignored by now.  The twosided option to the
  845. \documentstyle or \documentclass produces the corresponding RTF tokens.
  846. Note that these features require RTF Version 1.4.
  847.  
  848. 
  849. File: latex2rtf.info,  Node: Hyperlatex,  Prev: Pagestyles,  Up: Features
  850.  
  851. Hyperlatex
  852. ==========
  853.  
  854.    Hyperlatex support is largely broken at the moment, but continues to
  855. improve.
  856.  
  857.    Otfried Schwarzkopf has created the "Hyperlatex Markup Language"
  858. which is a "little package that allows you to use LaTeX  to prepare
  859. documents in HTML."  It brings an Emacs lisp program with it to convert
  860. the Hyperlatex file to HTML.  Hyperlatex can be obtained from the
  861. CTAN-sites, *Note Obtaining LaTeX2RTF::.  There are two convenient
  862. commands that avoid typing: \link and \xlink that generate an
  863. "internal" label which then is used in the following \Ref and \Pageref
  864. commands.
  865.  
  866.    LaTeX  makes it possible to write `\link{anchor}[ltx]{label}', which
  867. typesets: `anchor ltx'. LaTeX2RTF  does NOT support this aproach since
  868. the optional parameter is thrown away right now, *Note LaTeX2RTF under
  869. Development::.
  870.  
  871.    Note that you have to update your `.cfg' files if you are upgrading,
  872. since there are a lot of HTML oriented commands in Hyperlatex that we
  873. simply can `ignore'.
  874.  
  875. 
  876. File: latex2rtf.info,  Node: Configuration,  Next: Error Messages and Logging,  Prev: Features,  Up: Top
  877.  
  878. Configuration
  879. *************
  880.  
  881. * Menu:
  882.  
  883. * Input processing ::
  884. * Output formatting ::
  885. * Direct Conversion ::
  886. * Ignore Command ::
  887. * Font Configuration ::
  888. * Language Configuration ::
  889.  
  890. 
  891. File: latex2rtf.info,  Node: Input processing,  Next: Output formatting,  Prev: Configuration,  Up: Configuration
  892.  
  893. Input processing
  894. ================
  895.  
  896.    On processing input LaTeX2RTF  first converts the LaTeX  special
  897. characters. If it encounters one of the standard commands it is
  898. converted internally. If a command is not known to LaTeX2RTF  it is
  899. first looked up in `direct.cfg' and the RTF code specified there is
  900. output. If not found there it is looked up in the section `ignore.cfg'.
  901. This file includes a lot of LaTeX
  902.  
  903.    commands that do not affect the output (cross reference information
  904. and the like), or that we are not able or willing to convert to RTF.
  905.  
  906.    You can use `ignore.cfg' if you get tired of seeing
  907.      WARNING: command: `foo' not found - ignored
  908.     and you don't need `foo' in your RTF document.  It would be nice to
  909. send your additions to the LaTeX2RTF  mailing list for inclusion in
  910. later distributions.
  911.  
  912. LaTeX2RTF  accepts Unix, MS-DOS, and Macintosh line ending codes (\n,
  913. \r\n and \r).  The files it creates are the line ending for the
  914. platform on which LaTeX2RTF  was compiled.
  915.  
  916. The LaTeX  file may have been created with a wide variety of character
  917. sets.  If the LaTeX  lacks the `\package[codepage]{inputenc}'
  918. definition, then you may need to use the command line switch to manually
  919. select the proper code page. *Note Input Encoding::.
  920.  
  921. 
  922. File: latex2rtf.info,  Node: Output formatting,  Next: Direct Conversion,  Prev: Input processing,  Up: Configuration
  923.  
  924. Output formatting
  925. =================
  926.  
  927.    On writing output, LaTeX2RTF  generates `\n' as line ending code.
  928. Your RTF Reader should accept this on any platform. If you ftp your RTF
  929. file from or to MS-DOS platforms the line ending code can be converted
  930. to `\r\n'. As this should also be legal to any RTF Reader the resulting
  931. RTF rendering should not be affected.
  932.  
  933.    LaTeX2RTF  does not offer a whole lot of flexibility in how files
  934. are translated, but it does offer some.  This flexibility resides in
  935. four files `direct.cfg', `ignore.cfg', `fonts.cfg', and `language.cfg'.
  936. These filese are documented in the next four sections.
  937.  
  938. 
  939. File: latex2rtf.info,  Node: Direct Conversion,  Next: Ignore Command,  Prev: Output formatting,  Up: Configuration
  940.  
  941. Direct Conversion
  942. =================
  943.  
  944.    The file `direct.cfg' is used for converting LaTeX  commands by
  945. simple text replacement. The format consists of lines with a LaTeX
  946. command with backslash followed by comma. The rest of the line until a
  947. `.' character will be written to the RTF file when the command is found
  948. in the LaTeX  file. Lines starting with a `#' character are ignored.
  949. After the `.' everything is ignored to end of line. To select a
  950. specific font use `*fontname*', where `fontname' be defined in
  951. `fonts.cfg'.  To write the `*' character use `**'.
  952.      \alpha,{\f*Symbol* a}. #alpha in the Symbol Font
  953.      \copyright,\'a9.
  954.  
  955. 
  956. File: latex2rtf.info,  Node: Ignore Command,  Next: Font Configuration,  Prev: Direct Conversion,  Up: Configuration
  957.  
  958. Ignore Command
  959. ==============
  960.  
  961.    The file `ignore.cfg' is used for defining how to ignore specific
  962. commands. This file is used for recognition of LaTeX  variables, user
  963. defined variables, and some simple commands. All variables are ignored
  964. but the converter must know the names to correctly ignore assignments
  965. to variables. Lines in this file consist of a variable name with
  966. backslash, followed by comma and the type of the variable followed by
  967. `.'. Possible types are
  968.  
  969. `NUMBER'
  970.      simple numeric value
  971.  
  972. `MEASURE'
  973.      numeric value with following unit of measure
  974.  
  975. `OTHER'
  976.      ignores anything to the first character after `=' and from there
  977.      to next space. e.g., `\setbox\bak=\hbox'
  978.  
  979. `COMMAND'
  980.      ignores anything to next `\' and from there to the occurence of
  981.      anything but a letter e.g., `\newbox\bak'
  982.  
  983. `SINGLE'
  984.      ignore single command e.g., `\noindent'
  985.  
  986. `PARAMETER'
  987.      ignores a command with one parameter e.g., `\foo{bar}'
  988.  
  989. `PACKAGE'
  990.      does not produce a Warning message if PACKAGE is encountered, e.g.,
  991.      `PACKAGE,kleenex.'
  992.  
  993. `ENVCMD'
  994.      proceses contents of unknown environment as if it were plain LaTeX
  995.  
  996.      eg. `ENVCMD,environ.' Therefore `\begin{environ} text
  997.      \end{environ}'' as `text'.
  998.  
  999. `ENVIRONMENT'
  1000.      ignores contents of that environment, e.g., with
  1001.      `ENVIRONMENT,ifhtml.'  `\begin{ifhtml} text \end{ifhtml}' ignores
  1002.      `text'.
  1003.  
  1004.    The types are in upper case exactly as above. Do not use spaces.
  1005. Lines starting with a `#' character are ignored. After the `.'
  1006. everything is ignored to end of line. Example:
  1007.      \pagelength,MEASURE.
  1008.  
  1009. 
  1010. File: latex2rtf.info,  Node: Font Configuration,  Next: Language Configuration,  Prev: Ignore Command,  Up: Configuration
  1011.  
  1012. Font Configuration
  1013. ==================
  1014.  
  1015.    The file `fonts.cfg' contains the font name mapping.  For example,
  1016. this file determines what font is used to represent `\rm' characters in
  1017. the RTF file.
  1018.  
  1019.    A line consists of a font name in LaTeX  followed by comma and a font
  1020. name in RTF. The end is marked by a `.'. No spaces are allowed. The
  1021. LaTeX  font will be converted to the RTF font when it is found in the
  1022. LaTeX  file. If multiple translations for the same LaTeX  font are
  1023. specified, only the first is used. All fonts in a LaTeX  file that are
  1024. not in this file will be mapped to the default font. All RTF fonts
  1025. listed in this file will be in every RTF file header whether used or
  1026. not.  Lines starting with a `#' character are ignored. After the `.'
  1027. everything is ignored to end of line.
  1028.  
  1029.    To add a RTF font not used as substitute for a LaTeX  font -- for
  1030. example a Symbol font used in `direct.cfg' -- use a dummy LaTeX  name
  1031. like in the following
  1032.      Dummy3,MathematicalSymbols.
  1033.  
  1034.    Make sure you use the correct font name. Take care of spaces in font
  1035. names. The default fonts are named Roman `\rm', Slanted `\sl', Sans
  1036. Serif `\sf', Typewriter `\tt', or Calligraphic `\cal'.
  1037.  
  1038. 
  1039. File: latex2rtf.info,  Node: Language Configuration,  Prev: Font Configuration,  Up: Configuration
  1040.  
  1041. Language Configuration
  1042. ======================
  1043.  
  1044.    The file(s) `language.cfg' control the translation of LaTeX 's
  1045. "hardcoded" sectioning names.  The standard LaTeX  styles have some
  1046. fixed Title names like `Part', `Reference' or `Bibliography' that
  1047. appeared in English or German in the output with the original versions
  1048. of LaTeX2RTF .
  1049.  
  1050.    It is unlikely that you will need to create a new `language.cfg'
  1051. file.  However, just look at one of the existing files and follow the
  1052. pattern.  The format is really simple.
  1053.  
  1054. 
  1055. File: latex2rtf.info,  Node: Error Messages and Logging,  Next: History,  Prev: Configuration,  Up: Top
  1056.  
  1057. Error Messages and Logging
  1058. **************************
  1059.  
  1060.    As stated in the Debugging section, LaTeX2RTF  provides a means to
  1061. control the amount of debugging information through the `-d#' switch.
  1062. By using a debugging level of 4, you can get a pretty good idea of what
  1063. LaTeX  command caused the problem and what line that command might be
  1064. found on.
  1065.  
  1066. `Fatal error messages'
  1067.      indicate a bug in the source code. PLEASE report them, if they do
  1068.      not apear in the documentation. *Note Reporting Bugs::.
  1069.  
  1070. `Error messages'
  1071.      always abort the program and are caused by conditions that prevent
  1072.      further conversion of the input file.  Typically this is cause by
  1073.      LaTeX2RTF  getting hopelessly confused by the number of braces in
  1074.      the LaTeX  file.
  1075.  
  1076. `Warning messages'
  1077.      inform you, that there is some conversion loss from LaTeX  to RTF,
  1078.      or that the output file has some restrictions on some RTF Readers.
  1079.      Most of these warnings can be supressed by add the offending
  1080.      command to the `ignore.cfg' file.
  1081.  
  1082.    Error and Warning messages should follow the GNU Coding standards,
  1083. i.e. they have the format
  1084.      inputfile':line: Error|Warning: message
  1085.  
  1086.    You can also control the level of debugging output by inserting
  1087. `\verbositylevel{#}' in the LaTeX  file.  This is very handy if you
  1088. have a large LaTeX  file that is failing in only a small section.  For
  1089. example,
  1090.      problem free latex file ....
  1091.      \verbositylevel{5}
  1092.      problematic code
  1093.      \verbositylevel{0}
  1094.     will cause a huge amount of debugging information to be emitted for
  1095. the problematic code.
  1096.  
  1097. Error reporting and logging still has many inconsistencies, but it gets
  1098. better with each release.  Don't try to make any sense in debugging
  1099. levels above 4, these are for my own delight only and can change
  1100. significantly between versions.
  1101.  
  1102.    The `inputfile' may be incorrectly identified if it is incorporated
  1103. through `\input' or `\include'.  The line may be also be wrong at
  1104. times.  *Note Known Bugs::.
  1105.  
  1106. 
  1107. File: latex2rtf.info,  Node: History,  Next: LaTeX2RTF under Development,  Prev: Error Messages and Logging,  Up: Top
  1108.  
  1109. History & Copyright
  1110. *******************
  1111.  
  1112.    In 1994 the first Version of LaTeX2RTF  was written by Fernando
  1113. Dorner and Andreas Granzer of the Viena University supervised by Ralf
  1114. Schlatterbeck in a one-semester course. They created a simple LaTeX
  1115. parser and added most of the infrastructure for the program.  This was
  1116. version 1.0 of LaTeX2RTF .  In 1995, work on LaTeX2RTF  was continued
  1117. in another one-semester course by Friedrich Polzer and Gerhard Trisko.
  1118. The result was LaTeX2RTF  version 1.5.  Ralf Schlatterbeck
  1119. <ralf@zoo.priv.at> maintained and extended LaTeX2RTF  until 1998.
  1120.  
  1121.    In 1998 Georg Lehner <jorge_lehner@gmx.net> found the reference to
  1122. LaTeX2RTF  on the TeX Conversion Webpage
  1123. (http://tug.org/utilities/texconv/index.html)  of Wilfried Hennings and
  1124. added some functionality and took over the maintainence of the program.
  1125. The last version release by Georg is 1.8aa.  The bulk of development
  1126. post 1.8aa was done by Scott Prahl.  Wilfried Hennings now coordinates
  1127. the development of the program and maintains the project on SourceForge
  1128. (http://sourceforge.net/projects/latex2rtf/) where there are also (low
  1129. volume) mailing lists for users <latex2rtf-users@lists.sourceforge.net>
  1130. and developers <latex2rtf-developers@lists.sourceforge.net>.  For
  1131. subscription to these lists:
  1132. <latex2rtf-users-request@lists.sourceforge.net?subject=subscribe> or
  1133. <latex2rtf-developers-request@lists.sourceforge.net?subject=subscribe>
  1134.  
  1135.    As of October 2002, version 1.9.14 of LaTeX2RTF  is available.  One
  1136. day there shall be a jump to Version 2.0, but this is not history but
  1137. future ...
  1138.  
  1139.    The contents of this manual were composed by copying shamelessly
  1140. what was available in the original sources and documentation.
  1141.  
  1142. 
  1143. File: latex2rtf.info,  Node: LaTeX2RTF under Development,  Next: Index,  Prev: History,  Up: Top
  1144.  
  1145. LaTeX2RTF under Development
  1146. ***************************
  1147.  
  1148. * Menu:
  1149.  
  1150. * Unimplemented Features ::
  1151. * Missing options ::
  1152. * Known Bugs ::
  1153. * Reporting Bugs ::
  1154. * Todo List ::
  1155.  
  1156. 
  1157. File: latex2rtf.info,  Node: Unimplemented Features,  Next: Missing options,  Prev: LaTeX2RTF under Development,  Up: LaTeX2RTF under Development
  1158.  
  1159. Unimplemented Features
  1160. ======================
  1161.  
  1162.    * LaTeX2RTF  ignores some of the optional parameters of
  1163.      `\documentstyle'
  1164.  
  1165.    * Need to finish code page support.  Some characters that need to be
  1166.           constructed using RTF `\field' commands are not implemented.
  1167.  
  1168.    * Add the code to produce the corresponding chapter, section,
  1169.      and page numbering with headings and myheadings pagestyles.
  1170.      Implement       `\markboth' and `\markright'.
  1171.  
  1172.    * To support `\tableofcontents' there would be two approaches:
  1173.      Transfer       sectioning information, title text and then produce
  1174.      page numbers by the rtf-       reader. Scan and label all of the
  1175.      sectioning commands while reading and       then construct the
  1176.      sectioning information using these labels. Needs two       passes
  1177.      on LaTeX  input.
  1178.  
  1179.    * Include the GNU gettext package to internationalize LaTeX2RTF 's
  1180.      Messages.
  1181.  
  1182. 
  1183. File: latex2rtf.info,  Node: Missing options,  Next: Known Bugs,  Prev: Unimplemented Features,  Up: LaTeX2RTF under Development
  1184.  
  1185. Missing options
  1186. ===============
  1187.  
  1188.    Missing or buggy command line options.
  1189.  
  1190. `-V'
  1191.      The version information output is not compatible with the GNU
  1192.      Coding Standards.
  1193.  
  1194. `-d'
  1195.      Information logging and Error reporting is not implemented
  1196.      consistently.  Need to test and track problems with the linenumber
  1197.      and with the file name.
  1198.  
  1199. `-?'
  1200.      There should be an option to intersperse RTF-Output with the LaTeX
  1201.      input that produced it to aid debugging.
  1202.  
  1203. `-q'
  1204.      There should be a `-q' (quiet) option, to suppress Warning
  1205.      Messages. By now this can be achieved by the `-d0' option.
  1206.  
  1207. `-rmajor.minor'
  1208.      There should be an option that restrict the generation of RTF code
  1209.      with version greater than major,minor. Actually this is done at
  1210.      compile time.  There are some Warning messages if "newer" RTF Code
  1211.      is generated, but it is not consistent at all.
  1212.  
  1213. `--long_names'
  1214.      It would be useful to implement the GNU long option names, e.g.:
  1215.      `-debug', `-output_file', `-quiet', etc.  This could be done by
  1216.      switching to the GNU getopt package.
  1217.  
  1218. 
  1219. File: latex2rtf.info,  Node: Known Bugs,  Next: Reporting Bugs,  Prev: Missing options,  Up: LaTeX2RTF under Development
  1220.  
  1221. Known Bugs
  1222. ==========
  1223.  
  1224.   1. The first parameter of a \link{anchor}[ltx]{label} is converted to
  1225.      the       rtf-output. Label is stored to hyperref for later use,
  1226.      the optional       parameter is ignored. [ltx] should be processed
  1227.      as Otfried recommends it,       to use for exclusive LaTeX
  1228.      output.e.g: \link{readhere}[~\Ref]{explaining:       chapter}.
  1229.      Since {explaining:chapter} is yet read by LaTeX  and hyperlatex
  1230.        when [...] is evaluated it produces the correct reference.
  1231.      LaTeX2RTF  is       only strolling from left to right through the
  1232.      text and can't remember       what she will see in the future.
  1233.  
  1234.   2. The diagnostics routine does not output the correct (actual)
  1235.      inputfilename. (`.aux', `.bbl', `\input').
  1236.  
  1237. 
  1238. File: latex2rtf.info,  Node: Reporting Bugs,  Next: Todo List,  Prev: Known Bugs,  Up: LaTeX2RTF under Development
  1239.  
  1240. Reporting Bugs
  1241. ==============
  1242.  
  1243.    Report bugs to to the bug tracking system at SourceForge
  1244. (http://sourceforge.net/projects/latex2rtf/).  Only report bugs for the
  1245. latest version of LaTeX2RTF  that is available.   Please provide the
  1246. following information and observe the following guidelines when
  1247. reporting a bug in the program:
  1248.   1. State the version of LaTeX2RTF  that you are using.  You can get
  1249.      the version by specifying the `-V' option to LaTeX2RTF .
  1250.  
  1251.   2. Specify the your operating system and version. Be sure to check
  1252.      the file `Makefile' for settings that may be specific to your
  1253.      machine, especially for some versions of SunOS there may be
  1254.      settings which are needed to compile successfully. Do this before
  1255.      submitting a bug report.
  1256.  
  1257.   3. If the program produces wrong output or does not work for you,
  1258.      include a short LaTeX  file along with a description of the
  1259.      problem.  Isolating the bug into a small LaTeX  file does two
  1260.      things.  First, it provides a file that can be used to test future
  1261.      versions of LaTeX2RTF  and second, it certainly improves the
  1262.      chances that the bug will get some attention.  Do not send me
  1263.      large LaTeX  or RTF files, I simply do not have the time to wade
  1264.      through large files to search for a bug!
  1265.  
  1266.   4. Be patient. I am maintaining the program in my free time. I did not
  1267.      write most of the code. Often I do not have the time to answer to
  1268.      your question. I will, however, try to fix reported bugs in
  1269.      upcoming releases.
  1270.  
  1271. 
  1272. File: latex2rtf.info,  Node: Todo List,  Prev: Reporting Bugs,  Up: LaTeX2RTF under Development
  1273.  
  1274. Todo List
  1275. =========
  1276.  
  1277.    Scott's ToDo list
  1278.    * Use lex/yacc to implement getSection
  1279.  
  1280.    * Add support for pagestyle
  1281.  
  1282.    * Improve graphic/graphicx support
  1283.  
  1284.    * Better support for ignoring commands
  1285.  
  1286.    Georg's todo list
  1287.    * Make this Manual more consistent, the ToDo and Known Bug List
  1288.      shorter and       the Features List longer.
  1289.  
  1290.    * Harmonize all of the error and warning messages.
  1291.  
  1292.    * Put warnings everywhere applicable about producing RTF 1.4 tokens.
  1293.  
  1294.    * Provide an Error and Warning recovery guide to the user.
  1295.  
  1296.    * Add a chapter with lists of all LaTeX  commands that convert, and
  1297.      that do       not convert to RTF, including their status (for
  1298.      future releases, never,       partially functional, ...).
  1299.  
  1300. 
  1301. File: latex2rtf.info,  Node: Index,  Prev: LaTeX2RTF under Development,  Up: Top
  1302.  
  1303. Index
  1304. *****
  1305.  
  1306. * Menu:
  1307.  
  1308. * Copyright issues:                      History.
  1309. * History of the programm:               History.
  1310.  
  1311.  
  1312. 
  1313. Tag Table:
  1314. Node: Top79
  1315. Node: Introduction1377
  1316. Node: Installation4146
  1317. Node: General4439
  1318. Node: Obtaining LaTeX2RTF4777
  1319. Node: UNIX5718
  1320. Node: DOS or Windows8467
  1321. Node: Win32 systems13746
  1322. Node: Macintosh14652
  1323. Node: Problems Compiling15515
  1324. Node: Problems with make check16208
  1325. Node: Using LaTeX2RTF16729
  1326. Node: General Assumptions16930
  1327. Node: LaTeX2RTF Options18762
  1328. Node: Debugging25856
  1329. Node: Features26496
  1330. Node: LaTeX2e26866
  1331. Node: Input Encoding27178
  1332. Node: Language Support27929
  1333. Node: Cross References29313
  1334. Node: Equations31224
  1335. Node: Tables32470
  1336. Node: Graphics32649
  1337. Node: Pagestyles33008
  1338. Node: Hyperlatex33607
  1339. Node: Configuration34668
  1340. Node: Input processing34955
  1341. Node: Output formatting36327
  1342. Node: Direct Conversion37074
  1343. Node: Ignore Command37831
  1344. Node: Font Configuration39539
  1345. Node: Language Configuration40844
  1346. Node: Error Messages and Logging41458
  1347. Node: History43552
  1348. Node: LaTeX2RTF under Development45387
  1349. Node: Unimplemented Features45654
  1350. Node: Missing options46714
  1351. Node: Known Bugs47926
  1352. Node: Reporting Bugs48809
  1353. Node: Todo List50447
  1354. Node: Index51276
  1355. 
  1356. End Tag Table
  1357.